Metadata Services
This section of the document explains the Metadata services.
Repository Services
When repository services are invoked, they return information which is already created and existing in the system at various points of time like Product Plan details, Business Object Model (BOM) (schema), factor model, and domain details.
The below services have its own set of inputs required to invoke that.
getBOM
|
Service Name |
getBOM |
|
Description |
This service is used to get the BOM as schema based on the given product as input. Consuming systems must use this service during development or at runtime to get product or rating BOM structure. BOM structure is required to exchange data between consuming systems and iFoundry services. |
|
Input |
Product Name, Request Id (optional) |
|
Sample Input XML |
NA |
|
Output |
XML containing Schema (String) |
|
Sample Output XML |
To view a sample XML output file, refer toGetBOMServiceResponse.xml. |
|
REST URL |
Verb : GET; Produces: text/xml http://host:port/ifoundry/api/v1/metadata/bom/products/{productName}?testb ed={testbedName}& requestId={requestId} |
GetFactorGroupDetails
|
Service Name |
GetFactorGroupDetails |
|
Description |
This service is used to get the list of factor groups and the corresponding metadata based on the given type of factor groups (Risk, Coverage, Endorsement, Form, and Risk Extension). Metadata includes data type, occurrence, visibility, and source type. Examples of factor groups: Coverage, Location, and Limit. |
|
Input |
Product Name, EntityType, Request Id(optional) |
|
Sample Input XML |
NA |
|
Output |
List of Factor groups. Refer: FactorGroup. |
|
Sample Output XML |
To view a sample XML output file, refer toGetFactorGroupDetailsResponse.xml. |
|
REST URL |
Verb : GET; Produces: xml, json http://host:port/ifoundry/api/v1/metadata/factorgroupdetails/products/{produc tName}?testbed={testbedName}& withdetails={isWithDetails}& type={type}, requestId={requestId} |
GetFactorGroupDetailsByName
|
Service Name |
GetFactorGroupDetailsByName |
|
Description |
This service is used to get the factor group details and corresponding metadata for a given factor group name (Risk, Coverage, Endorsement, Form, and Risk Extension). Metadata includes data type, occurrence, visibility, and source type. Examples of factor groups are Coverage, Location, and Limit. |
|
Input |
Factor Group Name, Request Id (Optional) |
|
Sample Input XML |
NA |
|
Output |
Factor group details. Refer : FactorGroup |
|
Sample Output XML |
To view a sample XML output file, refer to GetFactorGroupDetailsByNameResponse.xml. |
|
REST URL |
Verb: GET; Produces: xml, json http://host:port/ifoundry/api/v1/metadata/factorgroupdetailsbyname/products/ {productName}/factorgroups/{factorGroupName}?testbed={testbedName}& requestId4={requestId} |
GetPlanDetails
|
Service Name |
GetPlanDetails |
| Description | This service is used to get the complete details of model (Risk, RiskExtension, Coverage, form, Endorsement and attribute) for given context in request. Examples of factor groups are Coverage, Location, and Limit. |
|
Input |
Context details. Refer: Context, Request Id (Optional) |
|
Sample Input XML |
To view a sample XML input file, refer to GetPlanDetails.xml Output |
|
Output |
PlanDetails.xml |
|
Sample Output XML |
To view a sample XML output file, refer to GetPlanDetailsResponse.xml. |
|
REST URL |
Verb: POST; Consumes: xml, json; Produces: text/xmlhttp://host:port/ifoundry/api/v1/metadata/plandetails?requestId={requestId} |
getMultiStateFactorDetails
|
Service Name |
GetMultiStateFactorDetails |
| Description |
The service is used to get Multi-State Factor details. |
|
Input |
Product Name Request ID (optional) |
|
Sample Input XML |
NA |
|
Output |
Refer: MultiStateFactorResponseDetails |
|
Sample Output XML |
To view a sample XML output file, refer to Get MultiStateFactorDetailsResponse.xml |
|
REST URL |
Verb: GET; Produces:xml, json http://host:port/ifoundry/api/v1/metadata/ multistatefactordetails /{productName}?requestId={requestId} |